<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>spips: XSpiPs Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">spips
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_spi_ps.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XSpiPs Struct Reference<div class="ingroups"><a class="el" href="group__spips__v3__0.html">Spips_v3_0</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_spi_ps.html" title="The XSpiPs driver instance data. ">XSpiPs</a> driver instance data.  
 <a href="struct_x_spi_ps.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a2f23279c800d3c5e2d91622b1fa64aeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_spi_ps___config.html">XSpiPs_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a2f23279c800d3c5e2d91622b1fa64aeb">Config</a></td></tr>
<tr class="memdesc:a2f23279c800d3c5e2d91622b1fa64aeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration structure.  <a href="#a2f23279c800d3c5e2d91622b1fa64aeb">More...</a><br /></td></tr>
<tr class="separator:a2f23279c800d3c5e2d91622b1fa64aeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b4bc94dfb1fa4b10dd398b6e2632d05"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a2b4bc94dfb1fa4b10dd398b6e2632d05">IsReady</a></td></tr>
<tr class="memdesc:a2b4bc94dfb1fa4b10dd398b6e2632d05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is initialized and ready.  <a href="#a2b4bc94dfb1fa4b10dd398b6e2632d05">More...</a><br /></td></tr>
<tr class="separator:a2b4bc94dfb1fa4b10dd398b6e2632d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827b441c0132c3ab87377efb81a027f2"><td class="memItemLeft" align="right" valign="top">u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a827b441c0132c3ab87377efb81a027f2">SendBufferPtr</a></td></tr>
<tr class="memdesc:a827b441c0132c3ab87377efb81a027f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to send (state)  <a href="#a827b441c0132c3ab87377efb81a027f2">More...</a><br /></td></tr>
<tr class="separator:a827b441c0132c3ab87377efb81a027f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c8a252eaab49a4fa19fcd688f36fea6"><td class="memItemLeft" align="right" valign="top">u8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a4c8a252eaab49a4fa19fcd688f36fea6">RecvBufferPtr</a></td></tr>
<tr class="memdesc:a4c8a252eaab49a4fa19fcd688f36fea6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to receive (state)  <a href="#a4c8a252eaab49a4fa19fcd688f36fea6">More...</a><br /></td></tr>
<tr class="separator:a4c8a252eaab49a4fa19fcd688f36fea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85a5e324de43e019ef15666bdc0685cd"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a85a5e324de43e019ef15666bdc0685cd">RequestedBytes</a></td></tr>
<tr class="memdesc:a85a5e324de43e019ef15666bdc0685cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes to transfer (state)  <a href="#a85a5e324de43e019ef15666bdc0685cd">More...</a><br /></td></tr>
<tr class="separator:a85a5e324de43e019ef15666bdc0685cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b08cdc0b7c5492d46a8e170941ba257"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a5b08cdc0b7c5492d46a8e170941ba257">RemainingBytes</a></td></tr>
<tr class="memdesc:a5b08cdc0b7c5492d46a8e170941ba257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes left to transfer(state)  <a href="#a5b08cdc0b7c5492d46a8e170941ba257">More...</a><br /></td></tr>
<tr class="separator:a5b08cdc0b7c5492d46a8e170941ba257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27b2c7d9c85bbe889cead27c5c384979"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a27b2c7d9c85bbe889cead27c5c384979">IsBusy</a></td></tr>
<tr class="memdesc:a27b2c7d9c85bbe889cead27c5c384979"><td class="mdescLeft">&#160;</td><td class="mdescRight">A transfer is in progress (state)  <a href="#a27b2c7d9c85bbe889cead27c5c384979">More...</a><br /></td></tr>
<tr class="separator:a27b2c7d9c85bbe889cead27c5c384979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d79fad73f829520b891e94b6e4536e1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a8d79fad73f829520b891e94b6e4536e1">SlaveSelect</a></td></tr>
<tr class="memdesc:a8d79fad73f829520b891e94b6e4536e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The slave select value when XSPIPS_FORCE_SSELECT_OPTION is set.  <a href="#a8d79fad73f829520b891e94b6e4536e1">More...</a><br /></td></tr>
<tr class="separator:a8d79fad73f829520b891e94b6e4536e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a012e4128cb1e93e765a8551512d91a77"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html#a012e4128cb1e93e765a8551512d91a77">StatusRef</a></td></tr>
<tr class="memdesc:a012e4128cb1e93e765a8551512d91a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback reference for status handler.  <a href="#a012e4128cb1e93e765a8551512d91a77">More...</a><br /></td></tr>
<tr class="separator:a012e4128cb1e93e765a8551512d91a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_spi_ps.html" title="The XSpiPs driver instance data. ">XSpiPs</a> driver instance data. </p>
<p>The user is required to allocate a variable of this type for every SPI device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2f23279c800d3c5e2d91622b1fa64aeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f23279c800d3c5e2d91622b1fa64aeb">&#9670;&nbsp;</a></span>Config</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_spi_ps___config.html">XSpiPs_Config</a> XSpiPs::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration structure. </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#ga1f40732e67f63579b811af115f2c575c">XSpiPs_Abort()</a>, <a class="el" href="group__spips__v3__0.html#ga66fc6e7b4ec94e279b89cc0eab2debf2">XSpiPs_CfgInitialize()</a>, <a class="el" href="group__spips__v3__0.html#gab8f7c1eb75848839d7dc4fa81bc273e4">XSpiPs_GetClkPrescaler()</a>, <a class="el" href="group__spips__v3__0.html#ga716d3d27606e693e765a2b9d01cce462">XSpiPs_GetDelays()</a>, <a class="el" href="group__spips__v3__0.html#ga842e4cf2fabf1849f451d9592d0b2722">XSpiPs_GetOptions()</a>, <a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler()</a>, <a class="el" href="group__spips__v3__0.html#gad3abd2456cfa67bc8d24dd255ba7de51">XSpiPs_Reset()</a>, <a class="el" href="group__spips__v3__0.html#gaaa797b9b8184e6f39b0c0038553e48d8">XSpiPs_SelfTest()</a>, <a class="el" href="group__spips__v3__0.html#ga8359f8188f7bf36a0688963aff561692">XSpiPs_SetClkPrescaler()</a>, <a class="el" href="group__spips__v3__0.html#gafe7ecd11569d8cf376ebc8f982503c52">XSpiPs_SetDelays()</a>, and <a class="el" href="group__spips__v3__0.html#gad1b67fe9b7737a1af8067d6d69e1508b">XSpiPs_SetOptions()</a>.</p>

</div>
</div>
<a id="a27b2c7d9c85bbe889cead27c5c384979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27b2c7d9c85bbe889cead27c5c384979">&#9670;&nbsp;</a></span>IsBusy</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpiPs::IsBusy</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A transfer is in progress (state) </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#ga66fc6e7b4ec94e279b89cc0eab2debf2">XSpiPs_CfgInitialize()</a>, <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, <a class="el" href="group__spips__v3__0.html#ga8359f8188f7bf36a0688963aff561692">XSpiPs_SetClkPrescaler()</a>, <a class="el" href="group__spips__v3__0.html#gafe7ecd11569d8cf376ebc8f982503c52">XSpiPs_SetDelays()</a>, <a class="el" href="group__spips__v3__0.html#gad1b67fe9b7737a1af8067d6d69e1508b">XSpiPs_SetOptions()</a>, <a class="el" href="group__spips__v3__0.html#ga1ef5af2211095df5692567fa4721a8d5">XSpiPs_SetSlaveSelect()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a2b4bc94dfb1fa4b10dd398b6e2632d05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b4bc94dfb1fa4b10dd398b6e2632d05">&#9670;&nbsp;</a></span>IsReady</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpiPs::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#gab8f7c1eb75848839d7dc4fa81bc273e4">XSpiPs_GetClkPrescaler()</a>, <a class="el" href="group__spips__v3__0.html#ga716d3d27606e693e765a2b9d01cce462">XSpiPs_GetDelays()</a>, <a class="el" href="group__spips__v3__0.html#ga842e4cf2fabf1849f451d9592d0b2722">XSpiPs_GetOptions()</a>, <a class="el" href="group__spips__v3__0.html#ga4efc98fb1e6b9a927146bd3bcab8ea8b">XSpiPs_GetSlaveSelect()</a>, <a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler()</a>, <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, <a class="el" href="group__spips__v3__0.html#gad3abd2456cfa67bc8d24dd255ba7de51">XSpiPs_Reset()</a>, <a class="el" href="group__spips__v3__0.html#gaaa797b9b8184e6f39b0c0038553e48d8">XSpiPs_SelfTest()</a>, <a class="el" href="group__spips__v3__0.html#ga8359f8188f7bf36a0688963aff561692">XSpiPs_SetClkPrescaler()</a>, <a class="el" href="group__spips__v3__0.html#gafe7ecd11569d8cf376ebc8f982503c52">XSpiPs_SetDelays()</a>, <a class="el" href="group__spips__v3__0.html#gad1b67fe9b7737a1af8067d6d69e1508b">XSpiPs_SetOptions()</a>, <a class="el" href="group__spips__v3__0.html#ga1ef5af2211095df5692567fa4721a8d5">XSpiPs_SetSlaveSelect()</a>, <a class="el" href="group__spips__v3__0.html#gacafc99130a16e99abb3d86e682f1de09">XSpiPs_SetStatusHandler()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a4c8a252eaab49a4fa19fcd688f36fea6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c8a252eaab49a4fa19fcd688f36fea6">&#9670;&nbsp;</a></span>RecvBufferPtr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8* XSpiPs::RecvBufferPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to receive (state) </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a5b08cdc0b7c5492d46a8e170941ba257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b08cdc0b7c5492d46a8e170941ba257">&#9670;&nbsp;</a></span>RemainingBytes</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpiPs::RemainingBytes</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of bytes left to transfer(state) </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler()</a>, <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a85a5e324de43e019ef15666bdc0685cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85a5e324de43e019ef15666bdc0685cd">&#9670;&nbsp;</a></span>RequestedBytes</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpiPs::RequestedBytes</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of bytes to transfer (state) </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler()</a>, <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a827b441c0132c3ab87377efb81a027f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a827b441c0132c3ab87377efb81a027f2">&#9670;&nbsp;</a></span>SendBufferPtr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8* XSpiPs::SendBufferPtr</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to send (state) </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer()</a>, and <a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer()</a>.</p>

</div>
</div>
<a id="a8d79fad73f829520b891e94b6e4536e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d79fad73f829520b891e94b6e4536e1">&#9670;&nbsp;</a></span>SlaveSelect</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XSpiPs::SlaveSelect</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The slave select value when XSPIPS_FORCE_SSELECT_OPTION is set. </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#ga4efc98fb1e6b9a927146bd3bcab8ea8b">XSpiPs_GetSlaveSelect()</a>.</p>

</div>
</div>
<a id="a012e4128cb1e93e765a8551512d91a77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a012e4128cb1e93e765a8551512d91a77">&#9670;&nbsp;</a></span>StatusRef</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XSpiPs::StatusRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback reference for status handler. </p>

<p class="reference">Referenced by <a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler()</a>, and <a class="el" href="group__spips__v3__0.html#gacafc99130a16e99abb3d86e682f1de09">XSpiPs_SetStatusHandler()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
